docs: Add Summary.to_json()#33
Merged
Marius Merkle (MariusMerkleQC) merged 1 commit intomainfrom Apr 14, 2026
Merged
Conversation
github-actions
bot
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #33 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 930 930
=========================================
Hits 930 930 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Marius Merkle (MariusMerkleQC)
requested review from
EgeKaraismailogluQC and
Oliver Borchert (borchero)
as code owners
Copilot started reviewing on behalf of
Marius Merkle (MariusMerkleQC)
April 14, 2026 08:59
View session
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for the Summary.to_json() API introduced in #28, so it appears in the generated docs and includes a concrete JSON output example.
Changes:
- Add
Summary.to_jsonto the Sphinx autosummary listing for the Summary API docs. - Expand
Summary.to_json()docstring withjson.dumpskwargs guidance and an example JSON payload.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/api/summary.rst | Exposes Summary.to_json in the generated API documentation. |
| diffly/summary.py | Improves Summary.to_json() docstring with kwargs details and an example JSON output. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Oliver Borchert (borchero)
approved these changes
Apr 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Forgot to add documentation and an example in #28.
Changes